home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Vk / VkTrace.z / VkTrace
Encoding:
Text File  |  1998-10-20  |  9.6 KB  |  199 lines
  1.  
  2.  
  3.  
  4. VVVVkkkkTTTTrrrraaaacccceeee((((3333xxxx))))                                                        VVVVkkkkTTTTrrrraaaacccceeee((((3333xxxx))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      VkTrace - Utility routines for tracing ViewKit applications
  10.  
  11. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  12.      #include <Vk/VkTrace.h>
  13.  
  14. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  15.           This package is a set of functions that can be used to generate
  16.           time-stamped traces from within ViewKit applications.  Traces are
  17.           normal ASCII files, intended for human perusal.  For normal VkApp
  18.           applications, the user must insert all calls into the source,
  19.           including initialization from within the application.  For VkMsgApp
  20.           applications, initialization, and some calls are already present.
  21.  
  22. GGGGLLLLOOOOBBBBAAAALLLL VVVVAAAARRRRIIIIAAAABBBBLLLLEEEE CCCCOOOONNNNTTTTRRRROOOOLLLLSSSS
  23.           Tracing is controlled by global variables that should be set as
  24.           early as possible within the application.  The variables are:
  25.  
  26.    vvvvkkkkTTTTrrrraaaacccceeeeEEEEnnnnaaaabbbblllleeee
  27.           If set, enables tracing.  All calls to VkTrace* will generate
  28.           records.  If clear, no tracing will occur.
  29.  
  30.    vvvvkkkkTTTTrrrraaaacccceeeeDDDDeeeettttaaaaiiiillllEEEEnnnnaaaabbbblllleeee
  31.           If set, enables detailed tracing.  All calls to VkTraceDetail* will
  32.           generate records.  If clear, no output from the VkTraceDetail* calls
  33.           will occur.
  34.  
  35.    vvvvkkkkTTTTrrrraaaacccceeeeMMMMeeeessssssssaaaaggggeeeeEEEEnnnnaaaabbbblllleeee
  36.           If set, trace records for all ToolTalk messages will be generated.
  37.  
  38.    vvvvkkkkTTTTrrrraaaacccceeeeMMMMeeeessssssssaaaaggggeeeeAAAArrrrggggssssEEEEnnnnaaaabbbblllleeee
  39.           If set, trace records for the arguments to ToolTalk messages will be
  40.           generated.
  41.  
  42. CCCCOOOONNNNTTTTRRRROOOOLLLLSSSS FFFFRRRROOOOMMMM WWWWIIIITTTTHHHHIIIINNNN VVVVkkkkMMMMssssggggAAAApppppppp AAAAPPPPPPPPLLLLIIIICCCCAAAATTTTIIIIOOOONNNNSSSS
  43.           VkMsgApp tracing is controlled by application resources as follows:
  44.  
  45.    TTTTrrrraaaacccceeeeEEEEnnnnaaaabbbblllleeee
  46.           Enables tracing.  If set, a file name for the trace is constructed
  47.           from the application class name, and the process pid.
  48.  
  49.    TTTTrrrraaaacccceeeeDDDDeeeettttaaaaiiiillllEEEEnnnnaaaabbbblllleeee
  50.           Enables detailed tracing.  If set, it will force TraceEnable, too.
  51.  
  52.    TTTTrrrraaaacccceeeeMMMMeeeessssssssaaaaggggeeeeEEEEnnnnaaaabbbblllleeee
  53.           Enables tracing of all ToolTalk messages.  If set, it also sets
  54.           TraceEnable.
  55.  
  56.    TTTTrrrraaaacccceeeeMMMMeeeessssssssaaaaggggeeeeAAAArrrrggggssssEEEEnnnnaaaabbbblllleeee
  57.           Enables tracing of the arguments to all ToolTalk messages.  If set,
  58.           it also sets TraceEnable.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVkkkkTTTTrrrraaaacccceeee((((3333xxxx))))                                                        VVVVkkkkTTTTrrrraaaacccceeee((((3333xxxx))))
  71.  
  72.  
  73.  
  74. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  75.           There are three sets of functions used to write traces.  All require
  76.           the VkTraceOpen call, and they differ in the format of the trace
  77.           messages.  VkTrace* records have a time stamp, VkTraceDetail records
  78.           do not, and are normally used as supplemental records following a
  79.           regular trace record, and VkTraceMark records have additional
  80.           information giving the time delta since the last VkTraceMark record.
  81.  
  82.    VVVVkkkkTTTTrrrraaaacccceeeeOOOOppppeeeennnn((((cccchhhhaaaarrrr ****ffffnnnnaaaammmmeeee))))
  83.           void VkTraceOpen(char *fname);
  84.  
  85.  
  86.           Opens a trace file with the given name.
  87.  
  88.    VVVVkkkkTTTTrrrraaaacccceeee((((cccchhhhaaaarrrr ****ssssttttrrrriiiinnnngggg))))
  89.           void VkTrace(char *string);
  90.  
  91.  
  92.           If vkTraceEnable is set, write a time-stamped trace record with the
  93.           given string.
  94.  
  95.    VVVVkkkkTTTTrrrraaaacccceeee2222((((cccchhhhaaaarrrr ****ssssttttrrrriiiinnnngggg,,,, cccchhhhaaaarrrr**** ppppaaaarrrraaaammmm))))
  96.           void VkTrace2(char *string, char* param);
  97.  
  98.  
  99.           If vkTraceEnable is set, write a time-stamped trace record with the
  100.           two given strings.
  101.  
  102.    VVVVkkkkTTTTrrrraaaacccceeeevvvv((((cccchhhhaaaarrrr ****ssssttttrrrriiiinnnngggg,,,, cccchhhhaaaarrrr ****ffffoooorrrrmmmmaaaatttt,,,, ............))))
  103.           void VkTracev(char *string, char *format, ...);
  104.  
  105.  
  106.           If vkTraceEnable is set, write a time-stamped trace record with the
  107.           given string, followed by additional text using the format string
  108.           and additional arguments.
  109.  
  110.    VVVVkkkkTTTTrrrraaaacccceeeeDDDDeeeettttaaaaiiiillll((((cccchhhhaaaarrrr ****ssssttttrrrriiiinnnngggg))))
  111.           void VkTraceDetail(char *string);
  112.  
  113.  
  114.           If vkTraceDetailEnable is set, write a trace record with the given
  115.           string.
  116.  
  117.    VVVVkkkkTTTTrrrraaaacccceeeeDDDDeeeettttaaaaiiiillll2222((((cccchhhhaaaarrrr ****ssssttttrrrriiiinnnngggg,,,, cccchhhhaaaarrrr**** ppppaaaarrrraaaammmm))))
  118.           void VkTraceDetail2(char *string, char* param);
  119.  
  120.  
  121.           If vkTraceDetailEnable is set, write a trace record with the two
  122.           given strings.
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. VVVVkkkkTTTTrrrraaaacccceeee((((3333xxxx))))                                                        VVVVkkkkTTTTrrrraaaacccceeee((((3333xxxx))))
  137.  
  138.  
  139.  
  140.    VVVVkkkkTTTTrrrraaaacccceeeeDDDDeeeettttaaaaiiiillllvvvv((((cccchhhhaaaarrrr ****ssssttttrrrriiiinnnngggg,,,, cccchhhhaaaarrrr ****ffffoooorrrrmmmmaaaatttt,,,, ............))))
  141.           void VkTraceDetailv(char *string, char *format, ...);
  142.  
  143.  
  144.           If vkTraceDetailEnable is set, write a trace record with the given
  145.           string, followed by additional text using the format string and
  146.           additional arguments.
  147.  
  148.    VVVVkkkkTTTTrrrraaaacccceeeeMMMMaaaarrrrkkkk((((cccchhhhaaaarrrr ****ssssttttrrrriiiinnnngggg))))
  149.            void VkTraceMark(char *string);
  150.  
  151.  
  152.           If vkTraceEnable is set, writes a trace record with the given
  153.           string.
  154.  
  155.    VVVVkkkkTTTTrrrraaaacccceeeeMMMMaaaarrrrkkkk2222((((cccchhhhaaaarrrr ****ssssttttrrrriiiinnnngggg,,,, cccchhhhaaaarrrr**** ppppaaaarrrraaaammmm))))
  156.            void VkTraceMark2(char *string, char* param);
  157.  
  158.  
  159.           If vkTraceEnable is set, write a trace record with the two given
  160.           strings.
  161.  
  162.    VVVVkkkkTTTTrrrraaaacccceeeeMMMMaaaarrrrkkkkvvvv((((cccchhhhaaaarrrr ****ssssttttrrrriiiinnnngggg,,,, cccchhhhaaaarrrr ****ffffoooorrrrmmmmaaaatttt,,,, ............))))
  163.            void VkTraceMarkv(char *string, char *format, ...);
  164.  
  165.  
  166.           If vkTraceEnable is set, write a trace record with the given string,
  167.           followed by additional text using the format string and additional
  168.           arguments.
  169.  
  170. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  171.      None.
  172.  
  173. CCCCLLLLAAAASSSSSSSSEEEESSSS UUUUSSSSEEEEDDDD BBBBYYYY TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
  174.      None
  175.  
  176. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  177.      VkComponent, VkWidgetList,
  178.      _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e
  179.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m, DEC Press, Bob Sheifler and Jim Gettys
  180.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m _T_o_o_l_k_i_t, DEC Press, Paul Asente and Ralph Swick
  181.      _T_h_e _O_S_F/_M_o_t_i_f _P_r_o_g_r_a_m_m_e_r_s _R_e_f_e_r_e_n_c_e, Prentice Hall, OSF
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.